<HTML>
<HEAD>
<TITLE>HELP - ParameterDocCombined</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - ParameterDocCombined < T, COUNT ></div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_class','HowToDocument0',this)" class="pathLink">HowToDocument</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">ParameterDocCombined<></span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_member','ParameterDocCombined955320382','_description',this)" class="tabLinkActive">Description</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_member','ParameterDocCombined955320382','_source',this)" class="tabLinkInActive">Source</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Call Graph</span></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<span class="paragraph1">HowToDocument::ParameterDocCombined<></span>
<span class="padding">( Public Inline Method Template General )</span>
<div class="paddingAuthor">Author:  N.F.S Grundtvig (The members of this class inherits the author by default.) </div>
<div class="paragraph2">Combining the ways to doc parameters for the template.<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2"><span id="descFunSynExpSpan" style="display:none;visibility:hidden"><a href="javascript:showElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSynExpSpan' );javascript:showElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'show' );"><img src="../../common/expand.gif" border=0></a></span><span id="descFunSynColSpan"><a href="javascript:showElement( 'descFunSynExpSpan' );javascript:hideElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'hide' );"><img src="../../common/collapse.gif" border=0></a></span>
Template syntax / parameters</div>
<div id="descFunSyn" class="paddingMembersTableDiv"><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top"><TD class="paddingHeadMultiColumn2"><span class="codeFont"><a href="#" OnMouseOver="link('_member','ParameterDocCombined955320382',this)">ParameterDocCombined</a> &lt; T, COUNT &gt;<br>
</span></TD></TR></TABLE>
<br><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Name</TD>
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Type</TD>
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Default</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>Description</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="codeFont" align=left>T</TD>
<TD class="paddingNormal1"><span class="codeFont" >class <br>
</TD>
<TD class="paddingNormal1"><span class="codeFont" align=left>&nbsp;</TD>
<TD class="paddingNormal2"><span class="" >Description of a template parameter. <b>Remember:</b> <a href="#" OnMouseOver="link('_class','Template23971',this)">Template</a> parameters <u>must</u> be described using <code>\param</code> keyword.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="codeFont" align=left>COUNT</TD>
<TD class="paddingNormal1"><span class="codeFont" >int <br>
</TD>
<TD class="paddingNormal1"><span class="codeFont" align=left>&nbsp;</TD>
<TD class="paddingNormal2"><span class="" >One more template parameter<br>
</TD>
</TR>
</table>
</div>
<div class="paragraph2"><span id="descFunSynExpSpan" style="display:none;visibility:hidden"><a href="javascript:showElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSynExpSpan' );javascript:showElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'show' );"><img src="../../common/expand.gif" border=0></a></span><span id="descFunSynColSpan"><a href="javascript:showElement( 'descFunSynExpSpan' );javascript:hideElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'hide' );"><img src="../../common/collapse.gif" border=0></a></span>
Syntax / parameters</div>
<div id="descFunSyn" class="paddingMembersTableDiv"><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top"><TD class="paddingHeadMultiColumn2"><span class="codeFont">int <a href="#" OnMouseOver="link('_member','ParameterDocCombined955320382',this)">ParameterDocCombined</a> (int iSize, HowToDocument &amp;howToDocument, float fMAX2=2.1f)<br>
</span></TD></TR></TABLE>
<br><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Name</TD>
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Type</TD>
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Default</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>Description</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="codeFont" align=left>iSize</TD>
<TD class="paddingNormal1"><span class="codeFont" >int <br>
</TD>
<TD class="paddingNormal1"><span class="codeFont" align=left>&nbsp;</TD>
<TD class="paddingNormal2"><span class="" >Parameter documentation for iSize<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="codeFont" align=left>howToDocument</TD>
<TD class="paddingNormal1"><span class="codeFont" >HowToDocument &amp; <br>
</TD>
<TD class="paddingNormal1"><span class="codeFont" align=left>&nbsp;</TD>
<TD class="paddingNormal2"><span class="" >Parameter documentation for TestDocBent<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="codeFont" align=left>fMAX2</TD>
<TD class="paddingNormal1"><span class="codeFont" >float <br>
</TD>
<TD class="paddingNormal1"><span class="codeFont" align=left>2.1f</TD>
<TD class="paddingNormal2"><span class="" >Parameter documentation for fMAX2<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingHeadBlank" colspan=4>&nbsp;</TD>
</TR>
<TR VALIGN="top">
<TD width=20% class="paddingHeadMultiColumn1"><span class="" align=left>Return value</TD>
<TD width=5% class="paddingNormal1"><span class="codeFont" >int<br>
</TD>
<TD width=5% class="paddingNormal1"><span class="" align=left>&nbsp;</TD>
<TD width=70% class="paddingNormal2"><span class="" >This is the return doc. <br>
</TD>
</TR>
</table>
</div>
<div class="paragraph2">Description</div>
<div id="descDesc" class="paddingMembers">Combining the ways to doc parameters for the template.<br>
<div class="userParagraph3">This is how it looks in the source:</div>
   <table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
  <TR VALIGN="top">
  <TD class="paddingHeadMultiColumn2">
<pre class="codeExamples">
\param T Description of a template parameter. #Remember:# <a href="#" onMouseOver="link('_class','Template23971',this); overLibDiagram();return overlib('',CAPTION,'<strong>Brief description</strong><BR>Template (specializations) example output.');" onMouseOut="return nd();">Template</a> parameters
{must{ be described using $\\param$ keyword.
\param COUNT One more template parameter
\return This is the return doc. 
template &lt;class T, int COUNT = 5 &gt;  
int                 <a href="#" onMouseOver="link('_member','ParameterDocCombined955320382',this); overLibDiagram();return overlib('<strong>Syntax</strong><BR>int&nbsp;&nbsp;ParameterDocCombined<BR>(int iSize, HowToDocument & howToDocument, float fMAX2)',CAPTION,'<strong>Brief description</strong><BR>Combining the ways to doc parameters for the template.');" onMouseOut="return nd();">ParameterDocCombined</a>( int iSize,                    ///&lt; Parameter documentation for iSize
                                          <a href="#" onMouseOver="link('_class','HowToDocument0',this); overLibDiagram();return overlib('<strong>Public Member Functions</strong><BR><TABLE><TR><TD>Author</TD><TD>BriefAndDescription</TD></TR><TR><TD>BriefCmd</TD><TD>BriefToNewline</TD></TR><TR><TD>Bug</TD><TD>CppDocCommentStyle</TD></TR><TR><TD>Deprecated</TD><TD>ExampleInclude</TD></TR><TR><TD>ExampleInline</TD><TD>ExceptionsThrown</TD></TR><TR><TD>IncludeDocFromBody</TD><TD>InlineFormattedCode</TD></TR><TR><TD>Internal</TD><TD>Note</TD></TR><TR><TD>OrgDoxygenDocComment</TD><TD>ParameterDocCombined<></TD></TR><TR><TD>Parameters</TD><TD>ParametersJavaStyle</TD></TR><TR><TD>ParametersTemplates<></TD><TD>Remark</TD></TR><TR><TD>ReturnValue</TD><TD>SeeAlso</TD></TR><TR><TD>Since</TD><TD>Todo</TD></TR><TR><TD>Version</TD><TD>Warning</TD></TR></TABLE>',CAPTION,'<strong>Brief description</strong><BR>HowTo document your code.');" onMouseOut="return nd();">HowToDocument</a>&amp; howToDocument, ///&lt; Parameter documentation for TestDocBent
                                          float fMAX2 = 2.1f            ///&lt; Parameter documentation for fMAX2
                                         )
{}
</pre>  </TD>
  </TR>
  </TABLE>
<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2">Source</div>
<div class="paddingMembers">The documentation for this Member was generated from the following file:</div>
<div class="paddingMembers"><LI><a href="#" onMouseOver="link('_file','HowtoDocument_h0',this); ">HowtoDocument.h</a><br></div>
<div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_member','_description');
</script>
